home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / xboard.z / xboard / man / cat6 / cmail.6 next >
Text File  |  1994-09-27  |  12KB  |  331 lines
  1.  
  2.  
  3.  
  4. CMAIL(6)                 GAMES AND DEMOS
  5.  
  6.  
  7.  
  8. NAME
  9.      cmail - an email chess helper
  10.  
  11. SYNOPSIS
  12.      cmail [options]
  13.  
  14. DESCRIPTION
  15.      The _c_m_a_i_l program will help you play  chess  by  email  with
  16.      opponents  of  your choice using an X interface.  To use it,
  17.      you will need to be able to run _x_b_o_a_r_d with which  _c_m_a_i_l  is
  18.      distributed,  available by anonymous FTP from numerous sites
  19.      around the world. It has been tested with _x_b_o_a_r_d _3._1; it may
  20.      require modification for other versions.
  21.  
  22. OPTIONS
  23.      You will usually run cmail without giving any options.   See
  24.      the next section for instructions.
  25.  
  26.      -h      Displays _c_m_a_i_l usage information.
  27.  
  28.      -c      Shows the  conditions  of  the  GNU  General  Public
  29.              License.
  30.  
  31.      -w      Shows the warranty notice of the GNU General  Public
  32.              License.
  33.  
  34.      -[x]v   Provides verbose output from _c_m_a_i_l (not _x_b_o_a_r_d) use-
  35.              ful for debugging, or inhibits it. The -xv form also
  36.              inhibits the cmail introduction message.
  37.  
  38.      -[x]mail
  39.              Invokes or inhibits the sending of  a  mail  message
  40.              containing the move.
  41.  
  42.      -[x]xboard
  43.              Invokes or inhibits the running  of  _x_b_o_a_r_d  on  the
  44.              game file.
  45.  
  46.      -[x]reuse
  47.              Invokes or inhibits the reuse of an existing  _x_b_o_a_r_d
  48.              to display the current game.
  49.  
  50.      -remail Resends the last mail message for  that  game.  This
  51.              inhibits running _x_b_o_a_r_d.
  52.  
  53.      -game _n_a_m_e
  54.              The name of the game to be processed.
  55.  
  56.      -opp _n_a_m_e
  57.              An alias for the opponent.
  58.  
  59.      -addr _a_d_d_r_e_s_s
  60.  
  61.  
  62.  
  63. ReadyPak                                                        1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CMAIL(6)                 GAMES AND DEMOS
  71.  
  72.  
  73.  
  74.              The opponent's email address.
  75.  
  76.      -event _e_v_e_n_t
  77.              The PGN Event  tag  (default  "Email  correspondence
  78.              game").
  79.  
  80.      -site _s_i_t_e
  81.              The PGN Site tag (default "NET").
  82.  
  83.      -round _r_o_u_n_d
  84.              The PGN Round tag (default "-", not applicable).
  85.  
  86.      -(white|black) _n_a_m_e
  87.              The PGN White/Black name tag (default "?", unknown).
  88.  
  89.      -(white|black)na _n_e_t _a_d_d_r_e_s_s
  90.              The PGN White/Black  network  address  tag  (default
  91.              "?", unknown).
  92.  
  93.      -mode _m_o_d_e
  94.              The PGN Mode tag (default "EM", Electronic Mail).
  95.  
  96.      -dir _d_i_r_e_c_t_o_r_y
  97.              The directory in which _c_m_a_i_l keeps its  files.  This
  98.              defaults  to  the  environment variable $CHESSDIR or
  99.              failing that, $HOME/Chess or  ~/Chess.  It  will  be
  100.              created if it does not exist.
  101.  
  102.      -mailprog _m_a_i_l _p_r_o_g_r_a_m
  103.              The program used by cmail to  send  email  messages.
  104.              This    defaults   to   the   environment   variable
  105.              $CMAIL_MAILPROG  or  failing  that  "/usr/ucb/Mail",
  106.              "/usr/ucb/mail" or "Mail".
  107.  
  108.      -gamesFile _f_i_l_e
  109.              A  file  containing  a  list  of  games  with  email
  110.              addresses. This defaults to the environment variable
  111.              $CMAIL_GAMES or failing that .cmailgames.
  112.  
  113.      -aliasesFile _f_i_l_e
  114.              A file containing one or more aliases for a  set  of
  115.              email  addresses.  This  defaults to the environment
  116.              variable    $CMAIL_ALIASES    or    failing     that
  117.              .cmailaliases.
  118.  
  119.      -logFile _f_i_l_e
  120.              A file in which to dump verbose  debugging  messages
  121.              that are invoked with the -v option.
  122.  
  123. OTHER OPTIONS
  124.      Any unrecognised flags will be passed to _x_b_o_a_r_d. Those  most
  125.      relevant for use with _c_m_a_i_l are:
  126.  
  127.  
  128.  
  129. ReadyPak                                                        2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CMAIL(6)                 GAMES AND DEMOS
  137.  
  138.  
  139.  
  140.      -oldSaveStyle (True | False), or -[x]oldsave
  141.              If this option is True, _x_b_o_a_r_d  uses  the  old  save
  142.              style for saving games, rather than the new PGN for-
  143.              mat. Newer versions of _c_m_a_i_l and  _x_b_o_a_r_d  understand
  144.              both  formats automatically without using this flag,
  145.              so it is only necessary on starting a new game where
  146.              Black uses the old _c_m_a_i_l (1.0).
  147.  
  148.      -timeDelay (or -td) _d_e_l_a_y
  149.              This sets the speed at which the moves are displayed
  150.              on start-up. It defaults to the environment variable
  151.              $CMAIL_TIME_DELAY if set, and 0 otherwise.
  152.  
  153.      -noChessProgram (True | False), or -[x]ncp
  154.              If this option is False, _x_b_o_a_r_d starts a chess  pro-
  155.              gram  which can be used with _c_m_a_i_l to suggest moves.
  156.              Default: True.
  157.  
  158.      -searchTime (or -st) minutes[:seconds]
  159.              Tells GNU Chess to spend at most the given amount of
  160.              time  searching for each of its moves.  Without this
  161.              option, GNU Chess chooses its search time  based  on
  162.              the  number  of  moves  and amount of time remaining
  163.              until the next time control.
  164.  
  165.      -searchDepth (or -sd) number
  166.              Tells GNU Chess to look  ahead  at  most  the  given
  167.              number  of  moves when searching for a move to make.
  168.              Without this option, GNU Chess  chooses  its  search
  169.              depth  based  on  the  number of moves and amount of
  170.              time remaining until the next time control.
  171.  
  172.      -saveGameFile (or -sgf) file
  173.              If this option is set, _x_b_o_a_r_d appends  a  record  of
  174.              the game played to the specified file on exit.
  175.  
  176.      -autosave or -autoSaveGames
  177.              If this option is True, at the  end  of  every  game
  178.              _x_b_o_a_r_d  prompts  you  for  a  filename and appends a
  179.              record of the game to the file you specify.
  180.  
  181.      -savePositionFile (or -spf) file
  182.              If this option is  set,  _x_b_o_a_r_d  appends  the  final
  183.              position reached to the specified file on exit.
  184.  
  185.      -boardSize (or -size) (Large | Medium | Small)
  186.              Determines how large the  board  will  be  and  what
  187.              built-in  piece  bitmaps  will  be used.  On a large
  188.              board (the default), pieces are 80x80 pixels,  on  a
  189.              medium  board  64x64  pixels,  and  on a small board
  190.              40x40 pixels.
  191.  
  192.  
  193.  
  194.  
  195. ReadyPak                                                        3
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. CMAIL(6)                 GAMES AND DEMOS
  203.  
  204.  
  205.  
  206. STARTING A GAME
  207.      Type _c_m_a_i_l from a shell.  After an opening message, you will
  208.      be  prompted  for  a  game name, which is optional -- if you
  209.      simply press return, the game name will take the  form  _y_o_u-
  210.      VS-_o_p_p_o_n_e_n_t.  You will next be prompted for the name of your
  211.      opponent.  If you haven't played  this  person  before,  you
  212.      will also be prompted for his/her email address.  _c_m_a_i_l will
  213.      then invoke _x_b_o_a_r_d in the background.  Make your first  move
  214.      and  select  _M_a_i_l  _M_o_v_e from the _F_i_l_e menu.  If all is well,
  215.      _c_m_a_i_l will mail a copy of the move to your opponent. If  you
  216.      select  _E_x_i_t  without having selected _M_a_i_l _M_o_v_e then no move
  217.      will be made.
  218.  
  219. ANSWERING A MOVE
  220.      When you receive a message from  an  opponent  containing  a
  221.      move  in  one of your games, simply pipe the message through
  222.      _c_m_a_i_l.  In some mailers this  is  as  simple  as  typing  "|
  223.      _c_m_a_i_l"  when  viewing  the  message, while in others you may
  224.      have to save the message to a file and do "_c_m_a_i_l < file"  at
  225.      the  command  line.   In  either case _c_m_a_i_l will display the
  226.      game using _x_b_o_a_r_d. If you didn't exit _x_b_o_a_r_d when  you  made
  227.      your  first  move  then  _c_m_a_i_l  will  do its best to use the
  228.      existing _x_b_o_a_r_d instead of starting a new  one.  As  before,
  229.      simply  make a move and select _M_a_i_l _M_o_v_e from the _F_i_l_e menu.
  230.      _c_m_a_i_l will try to use the _x_b_o_a_r_d that was most recently used
  231.      to  display the current game. This means that many games can
  232.      be in progress simultaneously,  each  with  its  own  active
  233.      _x_b_o_a_r_d.
  234.  
  235.      If you want to look at the history or explore  a  variation,
  236.      go ahead, but you must return to the current position before
  237.      _x_b_o_a_r_d will allow you to mail a move. If you edit the game's
  238.      history you must select _R_e_l_o_a_d _C_M_a_i_l _G_a_m_e from the _F_i_l_e menu
  239.      to get back to the original position, then make the move you
  240.      want  and  select  _M_a_i_l  _M_o_v_e.  As before, if you decide you
  241.      aren't ready to make a move just yet you can  either  select
  242.      _E_x_i_t  without  sending  a  move or just leave _x_b_o_a_r_d running
  243.      until you are ready.
  244.  
  245. TROUBLE SHOOTING
  246.      It's possible that a strange conjunction of  conditions  may
  247.      occasionally  mean  that  _c_m_a_i_l  has trouble reactivating an
  248.      existing _x_b_o_a_r_d. If this should happen trying it again might
  249.      work.  If  not, remove the file that stores the _x_b_o_a_r_d's PID
  250.      (<_g_a_m_e>.pid) or use the -_x_r_e_u_s_e option  to  force  _c_m_a_i_l  to
  251.      start a new _x_b_o_a_r_d.
  252.  
  253.      Older versions of _c_m_a_i_l do not  understand  the  PGN  format
  254.      which  _x_b_o_a_r_d  now uses. If your opponent uses an older ver-
  255.      sion of _c_m_a_i_l you will need to use the -_o_l_d_s_a_v_e flag to ini-
  256.      tiate a game with him/her.
  257.  
  258.  
  259.  
  260.  
  261. ReadyPak                                                        4
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. CMAIL(6)                 GAMES AND DEMOS
  269.  
  270.  
  271.  
  272. FILES
  273.      "._c_m_a_i_l_g_a_m_e_s" contains  a  list  of  games  with  the  email
  274.      addresses of the opponents.
  275.  
  276.      "._c_m_a_i_l_a_l_i_a_s_e_s" contains one or more aliases for  a  set  of
  277.      email addresses.
  278.  
  279. BUGS
  280.      No known bugs.
  281.  
  282. BUG REPORTS
  283.      I make no promises but if you send  bug  reports/suggestions
  284.      to  welsh@epcc.ed.ac.uk  I'll  do  my  best to fix/implement
  285.      them.
  286.  
  287. AUTHOR
  288.      Copyright (C) 1993  Free Software Foundation, Inc.
  289.  
  290.      _c_m_a_i_l is free  software;  you  can  redistribute  it  and/or
  291.      modify  it under the terms of the GNU General Public License
  292.      as published by the Free Software Foundation; either version
  293.      2 of the License, or (at your option) any later version.
  294.  
  295.      _c_m_a_i_l is distributed in the hope that it will be useful, but
  296.      WITHOUT  ANY  WARRANTY; without even the implied warranty of
  297.      MERCHANTABILITY or FITNESS FOR A  PARTICULAR  PURPOSE.   See
  298.      the GNU General Public License for more details.
  299.  
  300.      You should have received a copy of the  GNU  General  Public
  301.      License along with cmail; if not, write to the Free Software
  302.      Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  303.  
  304.      Author:   Evan Welsh <welsh@epcc.ed.ac.uk>
  305.                Edinburgh Parallel Computing Centre
  306.                JCMB, Kings Buildings
  307.                The University of Edinburgh
  308.                Edinburgh EH9 3JZ
  309.                Scotland
  310.  
  311. CONTRIBUTORS
  312.      Patrick Surry helped with design, testing and documentation.
  313.  
  314.      Tim Mann helped integrate _c_m_a_i_l with _x_b_o_a_r_d.
  315.  
  316. SEE ALSO
  317.      _x_b_o_a_r_d(1)
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327. ReadyPak                                                        5
  328.  
  329.  
  330.  
  331.